Range(cloud dedicated)
Function
This API is used to get the combined alarm parameter range.
Request Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| combined_alarm_info | 0 ~ 16 | array |
示例:
POST /API/AlarmConfig/Combination/Range HTTP/1.1
{
"version": "1.0",
"data": {}
}
Response Message
Parameter Description
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| serial_number | 0 ~ 16 | int | Joint alert index. |
| customized_alarm_state | bool | Whether the joint alarm is displayed. | |
| customized_alarm_name | 0 ~ 63 | string | The name of the joint alert. |
| switch_alarm | bool | Joint alarm switch. | |
| alarm_out | "Local->1"…"Local->x" "IP_CH1->1"…"IP_CHx->x" The number of channels depends on the function of the device. | string array | alarm Output channel. Array members use a string to represent an alarm output channel. Local->1:open, empty value: close. |
| latch_time | “5”，“10”，“20”，“30” | string | Alarm output time. |
| record_enable | true, false | bool | record enable. |
| record_channel | "CH1"…"CHx" "IP_CH1"…"IP_CHx" "WIFI_CH1"…"WIFI_CHx" | string array | Channel of linkage recording.（NVR dedicated） |
| post_recording | “30”，“60”，“120”，“300” | bool | Recording delay time. |
| combination_configure | 0 ~ 8 | array | For the alarm source configuration of the joint alarm, see Table 3 for details. |
| normal_linkage | object | Joint alarm linkage configuration items see Table 4 for details. |
Table 3
| Parameter | Range | Type | Description |
|---|---|---|---|
| serial_number2 | 0 ~ 8 | int | The index of the alarm source configuration item for the federated alarm. |
| configure_state | bool | Whether the alarm source configuration item for the joint alarm is displayed. | |
| alarm_type | "com_motion","com_io","com_lcd","com_sod", "com_pdvd","com_fd","com_cc","com_cd", "com_qd","com_lpd","com_rsd","com_sound", "com_vt","com_its","com_ren","com_ret","com_fired","com_tm" | string | Alert type to configure. |
| alarm_source | "CH1"..."CHx", "Local->1"..."Local->x" Channel number and alarm input | string | Configured alert source. Given in the range is the alert source options for each corresponding type. |
| normal_linkage | object | Joint alarm linkage configuration items see Table 4 for details. |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| buzzer | bool | Linkage buzzer switch. | |
| pop_up | bool | Linkage board end interface joint alarm frame prompt function. | |
| send_email | bool | Linkage send mail switch. | |
| http_listening | bool | Linkage PUSH switch. | |
| voice_prompts | bool | Linkage voice broadcast switch. | |
| voice_prompts_index | int array | File index (0~4294967295, 0 is None, that is, no audio file is selected). Each file is named as "index_filename" (1_i will try), when displayed on the page , to hide "index_", such as "1_i will try", only display "i will try". | |
| voice_prompts_select | int array | Play channel, counted by bit (bit0 is local, bit1 corresponds to front-end channel 1, bit2 corresponds to channel 2...). | |
| voice_prompts_time | object array | Broadcasting time period setting, there can be no time conflict in the 12 time periods, see Table 5 for details. | |
| voice_prompts_speaker_select | int array | Play ip speaker, counted by bit (bit0 is ip speaker 1, bit1 corresponds to front-end ip speaker 2...). |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| start_hour | 0~23 | int | Start time h. |
| start_minute | 0~59 | int | start time m. |
| start_second | 0~59 | int | start time s. |
| end_hour | 0~23 | int | end time h. |
| end_minute | 0~59 | int | end time m. |
| end_second | 0~59 | int | end time s. |
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"combined_alarm_info": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": [
{
"serial_number": {
"type": "int32",
"min": 1,
"max": 16
},
"customized_alarm_state": {
"type": "bool"
},
"customized_alarm_name": {
"type": "string",
"min_len": 0,
"max_len": 63
},
"switch_alarm": {
"type": "bool"
},
"alarm_out": {
"type": "array",
"min_size": 0,
"max_size": 17,
"items": {
"type": "string",
"items": [
"Local->1"
]
}
},
"latch_time": {
"type": "string",
"items": [
"10",
"20",
"40",
"60"
]
},
"record_enable": {
"type": "bool"
},
"record_channel": {
"type": "array",
"min_size": 0,
"max_size": 8,
"items": {
"type": "string",
"items": [
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8"
]
}
},
"post_recording": {
"type": "string",
"items": [
"30",
"60",
"120",
"300"
]
},
"combination_configure": {
"type": "array",
"min_size": 0,
"max_size": 8,
"items": [
{
"serial_number2": {
"type": "int32",
"min": 1,
"max": 8
},
"configure_state": {
"type": "bool"
},
"alarm_type": {
"type": "string",
"items": [
"com_motion",
"com_io",
"com_lcd",
"com_sod",
"com_pdvd",
"com_fd",
"com_cc",
"com_cd",
"com_qd",
"com_lpd",
"com_rsd",
"com_sound",
"com_vt",
"com_its",
"com_ren",
"com_ret",
"com_fired",
"com_tm"
]
},
"com_motion": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5",
"CH7"
]
}
}
},
"com_io": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"Local<-1",
"Local<-2",
"Local<-3",
"Local<-4",
"Local<-5",
"Local<-6",
"Local<-7",
"Local<-8"
]
}
}
},
"com_lcd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5",
"CH7"
]
}
}
},
"com_sod": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_pdvd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_fd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_cc": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_cd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_qd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_lpd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_rsd": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_sound": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5",
"CH7"
]
}
}
},
"com_vt": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5",
"CH7"
]
}
}
},
"com_its": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_ren": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_ret": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_fired": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
},
"com_tm": {
"type": "object",
"items": {
"alarm_source": {
"type": "string",
"items": [
"CH2",
"CH5"
]
}
}
}
}
]
},
"normal_linkage": {
"type": "object",
"items": {
"buzzer": {
"type": "bool"
},
"pop_up": {
"type": "bool"
},
"send_email": {
"type": "bool"
},
"http_listening": {
"type": "bool"
},
"voice_prompts": {
"type": "bool"
},
"voice_prompts_index": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": {
"type": "int32",
"min": 0,
"max": 65535
}
},
"voice_prompts_select": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": {
"type": "uint32",
"min": 0,
"max": 4294967295
}
},
"voice_prompts_speaker_select": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": {
"type": "uint32",
"min": 0,
"max": 4294967295
}
},
"voice_prompts_time": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": [
{
"start_hour": {
"type": "int32",
"min": 0,
"max": 23
},
"start_minute": {
"type": "int32",
"min": 0,
"max": 59
},
"start_second": {
"type": "int32",
"min": 0,
"max": 59
},
"end_hour": {
"type": "int32",
"min": 0,
"max": 23
},
"end_minute": {
"type": "int32",
"min": 0,
"max": 59
},
"end_second": {
"type": "int32",
"min": 0,
"max": 59
}
}
]
}
}
}
}
]
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.